Skip to content

docs(community): add a community showcase - #1739

Open
clay-good wants to merge 2 commits into
mainfrom
codex/docs-community-openspec-ui-1692
Open

docs(community): add a community showcase#1739
clay-good wants to merge 2 commits into
mainfrom
codex/docs-community-openspec-ui-1692

Conversation

@clay-good

@clay-good clay-good commented Aug 28, 2026 •
edited
Loading

Copy link
Copy Markdown
Collaborator

Status

LGTM. Documentation checks, independent review, and all required CI checks passed for the latest revision. Ready for final maintainer approval.

Motivation

Give the community a shared place to showcase projects and resources built with and for OpenSpec, while keeping individual project listings out of the main README.

What it does

  • Adds docs/community.md as a community-owned awesome list, with OpenSpec UI as its first entry.
  • Invites contributors to submit a one-line project link and description through a PR.
  • Asks entries to explain their OpenSpec relevance, avoid advertising and referral links, and disclose paid features or required accounts.
  • Replaces the README's project listing with a link in its Docs section and adds the page to the documentation index.
  • Makes independent maintenance and the absence of official endorsement explicit.

Closes #1692.

Proof it works

  • Rendered all three changed Markdown pages through GitHub's Markdown API.
  • Verified the README and documentation-index links resolve to the new page, the project listing appears only in the showcase, and contribution headings render correctly.
  • git diff --check passed.
  • Independent review of the revised documentation found no issues. CodeRabbit completed its review with no actionable comments.
  • CI passed: Linux, macOS, and Windows test suites, lint and type checking, and release tracking. CodeQL, dependency review, audit, website lockfile drift, and the Cloudflare Pages build also passed.
  • The first entry's description was checked against its public repository and implementation. The external application was not executed or security-audited.

Notes

Documentation only: no runtime, dependency, installation, or workflow changes. No local runtime tests were run; the full repository suites passed in CI on the updated PR. No dedicated changeset is needed.

Prepared with Codex using GPT-5, with an independent Codex subagent review.

Summary by CodeRabbit

  • Documentation
    • Added a Community Showcase page featuring an initial project and contribution guidelines.
    • Added links to the showcase from the main and documentation indexes.

@clay-good
clay-good requested a review from a team as a code owner August 28, 2026 19:29
@clay-good
clay-good requested review from alfred-openspec and removed request for a team August 28, 2026 19:29
@coderabbitai

coderabbitai Bot commented Aug 28, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 043ab9bd-f747-480b-b6a9-34f95c5e1f1d

📥 Commits

Reviewing files that changed from the base of the PR and between a0ddb60 and c65c277.

📒 Files selected for processing (3)
  • README.md
  • docs/README.md
  • docs/community.md

Included review availability: Your plan provides up to 10 included reviews per hour; 9 remain after this review.

📝 Walkthrough

Walkthrough

Changes

Community Showcase

Layer / File(s) Summary
Showcase page and navigation
docs/community.md, README.md, docs/README.md		 Added a Community Showcase page with an OpenSpec UI entry, maintenance disclaimer, and contribution guidelines. Added links to the page in both documentation indexes.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: ⚪ Minimal · up to c65c2

This documentation-only change adds a community showcase and links it from existing documentation indexes. No actionable merge-blocking risk remains beyond normal checks and maintainer review.

Suggested reviewers: alfred-openspec, tabishb

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Linked Issues check ✅ Passed The PR satisfies issue #1692 by adding OpenSpec UI to an independent community showcase and linking the showcase from the project documentation.
Out of Scope Changes check ✅ Passed All changes support the documented objectives. The PR contains only related documentation updates for the community showcase and its navigation links.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: adding a community showcase documentation page and related links.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (3 skipped: 3 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/docs-community-openspec-ui-1692

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@openspec-cloud

openspec-cloud Bot commented Aug 28, 2026

Copy link
Copy Markdown

Nothing to compare — no requirement applies to this change.

AI-generated · A citation proves the line exists, not that it makes the case — verify before acting.
Checked the 0 requirements selected for this PR at ade1d31 (255 total).
View results · Click Refresh, then Scan again in the check. Or comment /openspec-cloud.

@TabishB

TabishB commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

Readme section is valuable space, we're trying to explain the project at a high level. This kinda info should live outside of the main readme.

@clay-good clay-good changed the title docs(readme): list the independent openspec ui project docs(community): add a community showcase Aug 28, 2026
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Aug 28, 2026 •
edited
Loading

Copy link
Copy Markdown

Deploying openspec-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: c65c277
Status: ✅  Deploy successful!
Preview URL: https://e65ae72f.openspec-docs.pages.dev
Branch Preview URL: https://codex-docs-community-openspe.openspec-docs.pages.dev

View logs

@clay-good

clay-good commented Aug 28, 2026

Copy link
Copy Markdown
Collaborator Author

Moved the project listing into docs/community.md. The main README now contains only a link in its Docs section. The new page is a community-owned showcase with OpenSpec UI as the first entry, a one-line PR contribution format, and guidance on relevance, commercial disclosures, and independent support.

alfred-openspec
alfred-openspec approved these changes Aug 31, 2026
View reviewed changes

@alfred-openspec alfred-openspec left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed exact head c65c277. The project listing now lives outside the README body, both navigation links resolve correctly, the OpenSpec UI description matches its public repository, and the independent-maintenance and contribution guidance is clear. All required checks are green. LGTM.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@alfred-openspec alfred-openspec alfred-openspec approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Proposal: An independent visual workspace built around OpenSpec

3 participants

@clay-good @TabishB @alfred-openspec